🚀 [Feature]: Separate cleanup from release type and move ReleaseType to Publish.Module #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ptions in schema and related scripts
MariusStorhaug
changed the title
MariusStorhaug
changed the title
AutoCleanup to CleanupPrereleases and separate cleanup from release type
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the prerelease cleanup mechanism by renaming AutoCleanup to CleanupPrereleases and separating the cleanup decision from the ReleaseType enum. The cleanup logic is now computed independently based on the PR state and user preferences, making the behavior more explicit and easier to understand.
Changes:
- Renamed
Publish.Module.AutoCleanuptoPublish.Module.CleanupPrereleasesfor clarity - Removed
Cleanupfrom theReleaseTypeenum (now onlyRelease,Prerelease, orNone) - Moved
ReleaseTypeand the computedCleanupPrereleasesvalue toPublish.Modulesection instead ofRun
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| tests/scenarios/valid/PSModule.yml | Updated test configuration to use new Publish.Module.CleanupPrereleases structure |
| tests/scenarios/invalid-percent-target/PSModule.yml | Updated test configuration to use new Publish.Module.CleanupPrereleases structure |
| scripts/main.ps1 | Implemented the core refactoring: renamed setting, separated cleanup logic from ReleaseType, and added computed values to Publish.Module |
| scripts/Settings.schema.json | Updated schema to rename AutoCleanup to CleanupPrereleases, improved description, and removed 'Cleanup' from ReleaseType enum |
Comments suppressed due to low confidence (1)
scripts/Settings.schema.json:181
- The schema is missing the
ReleaseTypeproperty definition in thePublish.Modulesection. According to the PR description and the code changes inscripts/main.ps1(line 433),ReleaseTypeis now being added as a computed property toPublish.Module. The schema should include aReleaseTypeproperty here with the same structure as defined in theRunsection (type: string, enum: ["Release", "Prerelease", "None"]).
"properties": {
"Skip": {
"type": "boolean",
"description": "Skip module publish"
},
"CleanupPrereleases": {
"type": "boolean",
"description": "When enabled (default: true), automatically cleans up old prerelease tags when merging to main or when a PR is abandoned"
},
"AutoPatching": {
"type": "boolean",
"description": "Automatically apply patches"
},
"IncrementalPrerelease": {
"type": "boolean",
"description": "Use incremental prerelease versioning"
},
"DatePrereleaseFormat": {
"type": "string",
"description": "Date format for prerelease versions"
},
"VersionPrefix": {
"type": "string",
"description": "Prefix for version tags"
},
"MajorLabels": {
"type": "string",
"description": "Comma-separated labels that trigger major version bump"
},
"MinorLabels": {
"type": "string",
"description": "Comma-separated labels that trigger minor version bump"
},
"PatchLabels": {
"type": "string",
"description": "Comma-separated labels that trigger patch version bump"
},
"IgnoreLabels": {
"type": "string",
"description": "Comma-separated labels that prevent release"
},
"PrereleaseLabels": {
"type": "string",
"description": "Comma-separated labels that trigger a prerelease"
},
"UsePRTitleAsReleaseName": {
"type": "boolean",
"description": "Use pull request title as the GitHub release name"
},
"UsePRBodyAsReleaseNotes": {
"type": "boolean",
"description": "Use pull request body as the release notes content"
},
"UsePRTitleAsNotesHeading": {
"type": "boolean",
"description": "Add pull request title as H1 heading in release notes"
}
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…licate definition
…d logic in settings
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MariusStorhaug
changed the title
AutoCleanup to CleanupPrereleases and separate cleanup from release type
MariusStorhaug
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The release type calculation is now separated from cleanup logic, providing clearer control over when prereleases are cleaned up. The
ReleaseTypenow only has three values (Release,Prerelease, orNone), and cleanup is computed independently based on theAutoCleanupsetting.ReleaseType simplified to three values
Previously,
ReleaseTypecould be set toCleanupto trigger prerelease cleanup. Now,ReleaseTypeonly has three values:Release,Prerelease, orNone. The cleanup decision is computed separately based on:AutoCleanupis enabled in your settings (defaults totrue)This separation enables the abandoned PR cleanup scenario where a PR is closed without merging—the workflow can now trigger cleanup independently of whether a release is being created.
ReleaseType moved to Publish.Module output
The computed
ReleaseTypevalue is now stored inPublish.Module.ReleaseTyperather than in theRunobject. This organizes release-related computed values alongside other publish settings.Workflows should now reference:
fromJson(inputs.Settings).Publish.Module.ReleaseTypefor the release typefromJson(inputs.Settings).Publish.Module.AutoCleanupfor the cleanup decision (computed boolean)AutoCleanup behavior
The
AutoCleanupsetting continues to work as before, but the output value is now a computed boolean that indicates whether cleanup should actually occur (based on both the setting and the current context like merged PR or abandoned PR).